StoredLearningSession Class

Represents a learning session that persists information in LearningStore.

Namespace: Microsoft.LearningComponents.Storage

Assembly: Microsoft.LearningComponents.Storage.dll

Syntax
C#

public class StoredLearningSession : LearningSession

Constructors
Name Description
Ð StoredLearningSession (SessionView, AttemptItemIdentifier, PackageStore)

Access a LearningSession that is based on a user's attempt of the the content. The attempt must already have been started (Start) in order to use this constructor.

Properties
Name Description
Ð AttemptEndTime

Gets the time at which the attempt associated with this session ended. The returned time is UTC.

Ð AttemptId

Gets the unique id of the attempt being used in this session.

Ð AttemptStartTime

Gets the time which the attempt associated with this session started. The returned time is UTC.

Ð AttemptStatus

Returns the state of attempt that is being managed by this session.

Ð CompletionStatus

Gets or sets completion status for the session. Inherited from LearningSession.

Ð CurrentActivityDataModel

Gets the data model associated with the current activity in the session.

Ð CurrentActivityEntryPoint

Gets the launching point of the current activity. This may be an absolute Uri, which indicates the resource is not in the package, or a package-relative Uri.

Ð CurrentActivityId

Gets the unique identifier of the current activity. It is unique for all activities in the persisted storage location. Inherited from LearningSession.

Ð CurrentActivityIsActive

Gets a value which indicates whether the session has a current activity that is active. Returns false if there is no current activity in the session. Inherited from LearningSession.

Ð CurrentActivityKey

Gets the identifier of the current activity, as provided in the manifest. This is unique per session. Inherited from LearningSession.

Ð CurrentActivityResourceKey

Gets the identifier of the resource associated with the current activity. The key is derived from the resource identifier in the manifest. It is unique per session. Inherited from LearningSession.

Ð CurrentActivityResourceParameters

Gets the parameter string to provide to the resource in the activity when the resource is being rendered. An empty string is returned if the value does not exist. Inherited from LearningSession.

Ð CurrentActivityResourceType

Gets the type of resource of the current activity.

Ð CurrentActivityResourceXmlBase

Gets the xmlbase information for the resource of the currect activity. This uri will be the base uri for any references contained in that resource to other files in the package. The value may be a package-relative or absolute Uri. If the resource does not have an xmlbase value, this property returns null. Inherited from LearningSession.

Ð HasCurrentActivity

Gets a value which indicates if the session has a current activity.

Ð IsAbandonValid

Gets a boolean indicating if the session is in a state in which the Abandon method may be called.

Ð IsExitValid

Gets a boolean indicating if the session is in a state in which the Exit method may be called.

Ð IsReactivateValid

Returns true if the session is in a state where Reactivate may be called.

Ð IsResumeValid

Gets a boolean indicating if the session is in a state in which the Resume method may be called.

Ð IsSuspendValid

Gets a boolean indicating if the session is in a state in which the Suspend method may be called.

Ð LoggingOptions

Gets or sets the level of logging in this session. In order to log all sequencing operations, this value should be set before any session requests related to navigating the package, such as MoveNext or IsMoveToActivityValid.

Ð PackageFormat

Gets the format of the package being processed during this session. Inherited from LearningSession.

Ð ShowAbandon

Gets an indication if the user interface element to abandon the session should be shown.

Ð ShowExit

Gets an indication if the user interface element indicating 'exit' should be shown.

Ð ShowNext

Returns true if the associated user interface element indicating 'continue to next activity' should be shown.

Ð ShowPrevious

Gets an indication if the user interface element indicating 'return to previous activity' should be shown.

Ð ShowSave

Gets an indication if the user interface element to save the session should be shown.

Ð SuccessStatus

Gets success status for the session. Inherited from LearningSession.

Ð Title

Gets the title of the session. This is the title of the root activity in the session, if provided, otherwise, a default title is returned. Inherited from LearningSession.

Ð TotalPoints

Gets a points value for the session. Inherited from LearningSession.

Ð View

Gets the view of the current session. Inherited from LearningSession.

Methods
Name Description
Ð Abandon

Stops the session by abandoning all activities in the session.

Ð AbandonCurrentActivity

Stops the current activity by abandoning it without saving data and without further processing of navigation rules.

Ð CommitChanges

Saves any changes in the session that have occurred since the session was created or the session was previously committed. You must call this method before disposing the session to ensure session changes to the session are persisted to LearningStore.

ÐS CreateAttempt (PackageStore, UserItemIdentifier, ActivityPackageItemIdentifier)

Create an attempt on a specific package. The package must have already been added to LearningStore. Following this method, Start must be called in order to deliver the first activity. This method does not provide logging information for the session.

ÐS CreateAttempt (PackageStore, UserItemIdentifier, ActivityPackageItemIdentifier, LoggingOptions)

Create an attempt on a specific package. The package must have already been added to LearningStore. Following this method, Start or MoveToActivity must be called in order to deliver the first activity.

ÐS DeleteAttempt

Delete an existing attempt. This action permanently removes all data relating to this attempt from LearningStore. There is no way to recover deleted information.

Ð Exit

Immediately exits the session without processing any pending navigation requests.

Ð ExitCurrentActivity

Immediately exits the current activity without processing any pending navigation requests and without saving any data model values that have not been committed.

Ð ExpandSessionCache

Expands information from the cache information about the session into distinct column values within LearningStore.

Ð GetTableOfContents ()

Gets the table of contents information for the activity tree of the current session, without evaluating the sequencing rules to determine if activities are accessible in the current state of the session. Inherited from LearningSession.

Ð GetTableOfContents (bool)

Gets the table of contents information for the activity tree of the current session. Inherited from LearningSession.

Ð InvalidateSessionCache

Removes the cached version of session data for all activities in the non-active session. This method should be called prior to an application directly modifying any data within LearningStore pertaining to this attempt.

Ð IsMoveToActivityValid (long)

Gets a boolean value indicating whether or not moving to the selected activity is a valid operation. The selected activity is identified by its unique numerical id.

Ð IsMoveToActivityValid (string)

Gets a boolean value indicating whether or not moving to the selected activity is a valid operation.

Ð IsMoveToNextValid

Gets a boolean value indicating whether or not moving to the next activity is a valid operation.

Ð IsMoveToPreviousValid

Gets a boolean value indicating whether or not moving to the previous activity is a valid operation.

Ð MoveToActivity (long)

Makes the selected activity the current activity, using the unique activity id.

Ð MoveToActivity (string)

Makes the selected activity the current activity.

Ð MoveToNext

Moves to the next activity in the session. For a session that represents an active attempt, this is determined through sequencing rules of the package and the progress of the learner through it. In other views, this returns the next activity in a preorder traversal of the activity tree.

Ð MoveToPrevious

Moves to the previous activity in the session. For a session that represents an active attempt, this is determined through sequencing rules of the package. In other cases, it is determined by an in order traversal of the activity tree and navigation rules as defined in the package manifest are not enforced.

Ð ProcessFormData

Process the data returned from the client.

Ð ProcessNavigationRequests

Processes all of the pending navigation requests in the current activity's data model. Returns true if this caused a navigation request to execute.

Ð Reactivate

Reactivate a session that has been completed or abandoned.

Ð Render

Reads a file from within the package associated with this session and writes it to a stream.

Ð Resume

Resumes a suspended session. Once the session has been resumed, it is considered active.

Ð Start ()

Start the attempt associated with this session without taking special action to identify an activity for delivery.

Ð Start (bool)

Start the attempt associated with this session.

Ð Suspend

Temporarily suspends the the current session. It may be resumed at a later time.

Ï ValidateRenderPath

Validates that the requested path can be rendered. Throws the appropriate exception if the request is not allowed. Inherited from LearningSession.